home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection Student Program / ADC Tools Sampler CD Disk 3 1999.iso / Metrowerks CodeWarrior / Java Support / Java_Source / Java2 / src / javax / accessibility / AccessibleAction.java < prev    next >
Encoding:
Java Source  |  1999-05-28  |  2.3 KB  |  67 lines  |  [TEXT/CWIE]
  1. /*
  2.  * @(#)AccessibleAction.java    1.7 98/08/26
  3.  *
  4.  * Copyright 1997, 1998 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  *
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14.  
  15. package javax.accessibility;
  16.  
  17. /**
  18.  * The AccessibleAction interface should be supported by any object 
  19.  * that can perform one or more actions.  This interface
  20.  * provides the standard mechanism for an assistive technology to determine 
  21.  * what those actions are as well as tell the object to perform those
  22.  * actions.  Any object that can be manipulated should support this
  23.  * interface.  Applications can determine if an object supports the 
  24.  * AccessibleAction interface by first obtaining its AccessibleContext (see
  25.  * {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleAction}
  26.  * method.  If the return value is not null, the object supports this interface.
  27.  *
  28.  * @see Accessible
  29.  * @see Accessible#getAccessibleContext
  30.  * @see AccessibleContext
  31.  * @see AccessibleContext#getAccessibleAction
  32.  *
  33.  * @version     1.3 02/04/98 11:12:57
  34.  * @author    Peter Korn
  35.  * @author      Hans Muller
  36.  * @author      Willie Walker
  37.  */
  38. public interface AccessibleAction {
  39.  
  40.     /**
  41.      * Returns the number of accessible actions available in this object
  42.      * If there are more than one, the first one is considered the "default"
  43.      * action of the object.
  44.      *
  45.      * @return the zero-based number of Actions in this object
  46.      */
  47.     public int getAccessibleActionCount();
  48.  
  49.     /**
  50.      * Returns a description of the specified action of the object.
  51.      *
  52.      * @param i zero-based index of the actions
  53.      * @return a String description of the action
  54.      * @see #getAccessibleActionCount
  55.      */
  56.     public String getAccessibleActionDescription(int i);
  57.  
  58.     /**
  59.      * Perform the specified Action on the object
  60.      *
  61.      * @param i zero-based index of actions
  62.      * @return true if the the action was performed; else false.
  63.      * @see #getAccessibleActionCount
  64.      */
  65.     public boolean doAccessibleAction(int i);
  66. }
  67.